home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / g_quake / mapsyntx.zip / MAPSYNTX.TXT < prev    next >
Text File  |  1996-09-09  |  3KB  |  58 lines
  1. About:    Quake Map Syntax checker - v. 0.5, 96.09.08.
  2.  
  3. Author:   Mads Bondo Dydensborg - madsdyd@diku.dk
  4.  
  5. Syntax:   Syntax checks a Map file after a simplified set of rules:
  6.  
  7.     Map             ->   Entity Entity_List 
  8.     Entity_List     ->   Entity Entity_List | <e> 
  9.     Entity          ->   { Key_Value_List Brush_List } 
  10.     Key_Value_List  ->   Key_Value Key_Value_List | <e> 
  11.     Key             ->   "<any>" 
  12.     Value           ->   "<any>" 
  13.     Brush_List      ->   Brush Brush_List | <e> 
  14.     Brush           ->   { plane plane plane plane plane_list } 
  15.     Plane_List      ->   Plane Plane_List | <e> 
  16.     Plane           ->   Point Point Point Texture <num> <num> <num> Flag Flag 
  17.     Point           ->   ( <num> <num> <num> ) 
  18.     Texture         ->   <anynw> 
  19.     Flag            ->   <anynw>
  20.  
  21.     <e>             is nothing
  22.     <any>           is anything 
  23.     <anynw>         is anything that does not contain whitespace 
  24.     <num>           is an integer (qbsp accepts reals though)
  25.  
  26. Comments: Anything starting with // to an EOL marker is considered a comment.
  27.  
  28. Strict  : Qbsp accepts a slightly more loose syntax then the above;
  29.           Sometimes Reals can be used instead of Integers. Keys and Brushes
  30.           can be mixed more freely. One can discus if the four Plane in a brush
  31.           is a syntax requirement.
  32.  
  33. Semantic: If /T is not specified, the program will extract texture names from
  34.           wad files specified in "wad" keys in the order it meets them, and  
  35.           check Texture definitions against this information. A warning will 
  36.           be issued if a Texture is not found
  37.           For each Entity, it is checked that a "classname" key is present.
  38.           if not, a warning will be issued.
  39.  
  40. Recovery: The program will try and recover from all syntax errors. Recovery
  41.           will often fail when meeting errors in keys, or non-closed brushes
  42.           in non-closed entities. The program will assume a recovery fail
  43.           initiated loop after 20 errors and stop.
  44.  
  45. Wadfiles: Wadfiles are assumed to be internally OK. This can cause some runtime
  46.           errors, if the wadfiles are broken. Try running with /T. If this
  47.           removes the runtime errors, the wadfiles internal dir probably is
  48.           incorrect.
  49.  
  50. Source:   If you are interessted in the source code to this program, then
  51.           contact me on the above adress.
  52.  
  53. Returns:  The program will return the following errorlevel:
  54.           0 - Normal termination.
  55.           1 - Warnings were issued
  56.           2 - Errors were found
  57.           3 - Error in program options (Illegal option combination)
  58.